home *** CD-ROM | disk | FTP | other *** search
/ Apple Reference & Presen…tion Library 4 (Reseller) / Apple Ref. & Pres. Lib.v4.0.iso / 5-Fonts & Software / Applications / Microsoft Word / AutoMac III 2.1 / MacroEditor.help < prev   
Text File  |  1988-08-19  |  13KB  |  407 lines

  1. ------------------------------------------------------------------------
  2.  BUTTON:    WHAT IT DOES:
  3. ------------------------------------------------------------------------
  4.  
  5.  OK        Quit the editor, change the macro as specified
  6.  Cancel    Quit the editor, cancel any changes made
  7.  Check        Test macro for correctness (does nothing if no errors)
  8.  
  9.  New        Delete all text
  10.  Open        Replace all text with text from a file on the disk
  11.  Save As    Save all text to a new text file on the disk
  12.  Revert    Go back to original text, as editor was entered
  13.  
  14.  
  15. ------------------------------------------------------------------------
  16.  TERMS:    DEFINITION:
  17. ------------------------------------------------------------------------
  18.  
  19.  Key number    A number that identifies the position of a key
  20.         on the keyboard.  Each key has its own number.
  21.  
  22.  Tick        The smallest time interval the Macintosh measures.
  23.         There are 60 ticks each second.
  24.  
  25.  Pixel        The size of the smallest dot on the screen.
  26.         On most screens, there are about 72 pixels
  27.         per inch.  All distances are measured in pixels.
  28.  
  29.  Relative    Refers to where the "origin point" is, from which
  30.         all measurements are made.  For example, the origin 
  31.         point is often the top left corner of the frontmost 
  32.         window.  All measurements are "relative to" the
  33.         current origin point.
  34.  
  35.  
  36. ------------------------------------------------------------------------
  37.  A RECORDED MACRO:          MEANING OF EACH LINE:
  38. ------------------------------------------------------------------------
  39.  
  40.  NAME    Test macro          Define the macro's name
  41.  KEYS    Option-T    17      Define key combo; key no. of "T" = 17
  42.  
  43.  Menu        File, New      Select "New" in the "File" menu.
  44.  RelTopLeft              Relative to top left of front window:
  45.  Click        58, 51  (8)      Click at 58,51 and hold for 8 "ticks"
  46.  Shift                  Press shift key down, and hold down
  47.  H        4          Type letter "H", with key no. = 4
  48.  KeysOff              Release Shift key (all modifier keys)
  49.  e        14          Type letter "e", with key no. = 14
  50.  l        37          ...
  51.  l        37          ...
  52.  o        31          ...
  53.  .        47          Type a period, with key no. = 47
  54.  Return    36          Press return key, with key no. = 36
  55.  
  56.  
  57. ------------------------------------------------------------------------
  58.  ANY COMMAND LINE MAY HAVE THE FOLLOWING ITEMS:
  59. ------------------------------------------------------------------------
  60.  
  61.  <time delay>  <command word>  <parameters>       \     *<comment>
  62.  
  63.  
  64.     <time delay>    = optional delay prior to the command, in ticks
  65.     <command word>  = what is to be done, e.g. "Click", "Move", etc.
  66.     <parameters>    = other items required, e.g. x and y coordinates
  67.     \              = may be used to continue a command on next line
  68.     *            = begins a comment; all else on line is ignored
  69.  
  70.  
  71.     NOTE:
  72.  
  73.     The NAME and KEYS lines must be located first in the macro.
  74.     Everything else, including comments, must be placed below,
  75.     within the "body" of the macro.
  76.  
  77.  
  78. ------------------------------------------------------------------------
  79.  COMMAND REFERENCE (ALPHABETICAL ORDER):
  80. ------------------------------------------------------------------------
  81.  
  82.  Beep
  83.  
  84.     Beeps the speaker once.
  85.  
  86. ........................................................................
  87.  
  88.  Char   <ASCII value>  <key# code>
  89.  
  90.      Types a single character, when given an
  91.      ASCII value.  The key number is optional.
  92.  
  93. ........................................................................
  94.  
  95.  Click  <y position>, <x position>   (<click time>)
  96.  
  97.      Clicks the mouse at a point on the screen,
  98.      relative to the current origin point.
  99.      Coordinates are in pixels, and measured
  100.      downwards and to the right.  The click time
  101.      is measured in ticks, or 60ths of a second.
  102.  
  103. ........................................................................
  104.  
  105.  Command-Option-Shift
  106.  
  107.     (Any combination.)  Causes one or more 
  108.     modifier keys to be "pressed" and held down.
  109.     Any combination of the three may be specified.  
  110.     Must be "released" with a KeysOff command.
  111.  
  112. ........................................................................
  113.  
  114.  DoAlert  <#buttons>,<time>,<button1text>,<button2text>,       \
  115.        <vpos>,<hpos>, <vsize>,<hsize>, <vinset>,<hinset>,   \
  116.        <text of the alert box>
  117.  
  118.         Does an alert or message box.  The "\" symbol
  119.         allows a single line to be broken up into more
  120.         than one.  The values are the same as those
  121.         entered when recording an alert box.  Button
  122.         text items should only be entered if buttons
  123.          exist.
  124.  
  125. ........................................................................
  126.  
  127.  Down  <y position>, <x position>
  128.  
  129.      Presses the mouse button down at a point
  130.      on the screen, relative to the current
  131.      origin point.  Coordinates are in pixels,
  132.      and measured downwards and to the right.
  133.      Must eventually be followed by an "Up",
  134.      so the button will be released.
  135.  
  136. ........................................................................
  137.  
  138.  FullSpeed
  139.  
  140.     Causes time delay values on following lines
  141.     to be ignored, so the macro will play at the 
  142.     fastest speed possible.  Opposite of a 
  143.     "RealTime" command.
  144.  
  145. ........................................................................
  146.  
  147.  JumpMacro  <key combination>  <key# code>
  148.  
  149.     Jumps to a macro, given its key combination.
  150.     Must include a key number code in this case.
  151.     (Key name is not significant; any name may
  152.     be used, such as "XX".)
  153.  
  154. ........................................................................
  155.  
  156.  <key name>  <key# code>
  157.  
  158.     A single key name on a line causes that key
  159.     to be pressed.  Some special key names 
  160.     allowed are Return, Enter, Tab, Backspace,
  161.     Digit0, Digit1, ..., Digit9.  (Note that
  162.     a digit such as "9" can't be placed first
  163.     on the line, because it will be mistaken
  164.     for a time delay value.)  The key number
  165.     code is optional.
  166.  
  167. ........................................................................
  168.  
  169.  Keys  <key combination>  <key# code>
  170.  
  171.     Defines the key combination of the macro,
  172.     such as Command-Option-S.  The key number
  173.     is optional, but if not entered, you will
  174.     be asked to press the key you mean when
  175.     you exit from the editor.
  176.  
  177.     [When you change the key combination, it
  178.     is simplest to ERASE the key number.  You 
  179.     will then be asked to press the key when
  180.     you click OK.  This will automatically
  181.     enter the new key number value.]
  182.  
  183. ........................................................................
  184.  
  185.  KeysOff
  186.  
  187.     "Releases" any combination of Shift,
  188.     Command and/or Option keys that is 
  189.     currently being "held down".
  190.  
  191. ........................................................................
  192.  
  193.  Menu  <menu name>, <item name>
  194.  
  195.     Selects an item from a menu, by name.  For the
  196.     apple menu use the word "Apple" as the menu name.
  197.  
  198.     For desk accessories, there must be a "+" in front of
  199.     the item name.  This symbolizes the hidden "null"
  200.     character that begins desk accessory names.
  201.  
  202.     Note: the Menu command does not work for special, 
  203.     custom menus.  Instead, menu selections will be
  204.     recorded as simple mouse drags.  For unusual cases
  205.     such as heirarchical menus, experiment with the
  206.     various recording options.
  207.  
  208. ........................................................................
  209.  
  210.  Move    <change in y>, <change in x>    
  211.  
  212.     Moves the mouse from where it currently is.
  213.     Coordinates are in pixels, and motion is 
  214.     measured downward and to the right.
  215.     For example, "Move 3,-1" would move the mouse
  216.     three pixels downward, and -1 to the right
  217.     (meaning 1 to the left).
  218.  
  219. ........................................................................
  220.  
  221.  MoveTo  <y position>, <x position>
  222.  
  223.     Moves the mouse to a point on the screen,
  224.     relative to the current origin point.
  225.     Coordinates are in pixels, and measured
  226.     downwards and to the right.
  227.  
  228. ........................................................................
  229.  
  230.  Name    <string>                
  231.  
  232.     Defines the name of the macro, as seen in the
  233.     main dialog box.
  234.  
  235. ........................................................................
  236.  
  237.  Pause  <hrs> : <mins> : <secs> : <ticks>
  238.  
  239.     Causes the macro to pause temporarily, for
  240.     the time specified.  Will be ignored unless
  241.     a RealTime command has been given.  All four
  242.     numbers must be entered, even if 0.
  243.  
  244. ........................................................................
  245.  
  246.  RealTime
  247.  
  248.     Causes time delay values in following lines
  249.     to be recognized (otherwise they are ignored).
  250.     Opposite of a "FullSpeed" command.
  251.  
  252. ........................................................................
  253.  
  254.  RelBotLeft
  255.  
  256.     Sets the current "origin point" at the lower left
  257.     corner of the frontmost window.  All future Click, 
  258.     Down, Up and MoveTo commands will be measured 
  259.     from that point.
  260.  
  261. ........................................................................
  262.  
  263.  RelBotRight
  264.  
  265.     Sets the current "origin point" at the lower right
  266.     corner of the frontmost window.  All future Click, 
  267.     Down, Up and MoveTo commands will be measured 
  268.     from that point.
  269.  
  270. ........................................................................
  271.  
  272.  RelScreen
  273.  
  274.     Sets the current "origin point" at the upper left
  275.     corner of the screen.  All future Click, Down, Up
  276.     and MoveTo commands will be measured from that point.
  277.  
  278. ........................................................................
  279.  
  280.  RelTopLeft    
  281.  
  282.     Sets the current "origin point" at the upper left
  283.     corner of the frontmost window.  All future Click, 
  284.     Down, Up and MoveTo commands will be measured 
  285.     from that point.
  286.  
  287. ........................................................................
  288.  
  289.  RelTopRight
  290.  
  291.     Sets the current "origin point" at the upper right
  292.     corner of the frontmost window.  All future Click, 
  293.     Down, Up and MoveTo commands will be measured 
  294.     from that point.
  295.  
  296. ........................................................................
  297.  
  298.  RelStart
  299.  
  300.     Sets the current "origin point" at the point
  301.     the mouse was at when the macro started playing.
  302.     All future Click, Down, Up and MoveTo commands 
  303.     will be measured from that point.
  304.  
  305. ........................................................................
  306.  
  307.  SetStart
  308.  
  309.     Changes the "starting point" of the macro to the
  310.     current mouse location.  The starting point is
  311.     normally where the mouse was when the macro
  312.     began playing.
  313.  
  314. ........................................................................
  315.  
  316.  <time delay>  <any command>
  317.  
  318.     A number placed FIRST on any line is
  319.     recognized as a time delay value in ticks,
  320.     or 60ths of a second.  The command on the
  321.     line will be delayed for that amount of time.
  322.  
  323.     [Note: time delays will be ignored unless a 
  324.     RealTime command has been given earlier.]
  325.  
  326. ........................................................................
  327.  
  328.  Type  <string>
  329.  
  330.     Types any specified phrase.  The phrase 
  331.     extends only up to the end of the line.
  332.     Use additional Type commands to type
  333.     more text.
  334.  
  335. ........................................................................
  336.  
  337.  Up    <y position>, <x position>
  338.  
  339.     Releases the mouse button at a point
  340.     on the screen, relative to the current
  341.     origin point.  Coordinates are in pixels,
  342.     and measured downwards and to the right.
  343.     Always follows a "Down" command, so that
  344.     the mouse button can be released.
  345.  
  346. ........................................................................
  347.  
  348.  WaitClock    <hr> : <min> : <sec>  <am or pm>
  349.  
  350.     Causes the macro to stop playing until a
  351.     certain time of day  All three numbers
  352.     must be entered, and "am" or "pm" is
  353.     also required.
  354.  
  355. ........................................................................
  356.  
  357.  WaitDate  <year>:<month>:<day> : <hr>:<min>:<sec>  <am or pm>
  358.  
  359.     Causes the macro to stop playing until a
  360.     certain date and time  All six numbers
  361.     must be entered, and "am" or "pm" is
  362.     also required.  (Note: the macro will not 
  363.     survive if the computer is shut off during
  364.     this period)
  365.  
  366. ........................................................................
  367.  
  368.  WaitEvent  <Return and/or Enter and/or AnyKey and/or Click>
  369.  
  370.     Causes the macro to stop playing until 
  371.     a certain event.  Up to 4 words are allowed,
  372.     including Return, Enter, AnyKey, and Click.
  373.     No commas are used between the words.
  374.  
  375. ........................................................................
  376.  
  377.  WaitPeriod  <hrs> : <mins> : <secs> : <ticks>
  378.  
  379.     Causes the macro to stop playing until a
  380.     certain time has passed.  All four numbers
  381.     must be entered, though the minimum
  382.     resolution is one second.
  383.  
  384. ........................................................................
  385.  
  386.  WindowPause
  387.  
  388.     Causes the macro to pause until a few cycles
  389.     through the current program's "event loop".
  390.     Often seen in macros that were recorded,
  391.     in order to improve playback performance.
  392.  
  393.  
  394. ------------------------------------------------------------------------
  395. COMMAND KEYS FOR BUTTONS
  396. ------------------------------------------------------------------------
  397.  
  398.     Command-H    Help
  399.     Command-T    Check
  400.     Command-X    Cut
  401.     Command-C    Copy
  402.     Command-V    Paste
  403.     Command-N    New
  404.     Command-O    Open
  405.     Command-A    Save As
  406.     Command-R    Revert
  407.     Command-.    Cancel